docs(integrations): add framework README#4722
Conversation
There was a problem hiding this comment.
Pull request overview
Documentation-only PR adding a developer-facing README for the Reader Activation Integrations framework, modeled on the data-events README.
Changes:
- New
includes/reader-activation/integrations/README.mddescribing framework purpose, file map, registration flow, push/pull pipelines, settings, data event handlers, ActionScheduler groups, health checks, My Account endpoints, and frontend registration.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Hey @miguelpeixe, good job getting this PR merged! 🎉 Now, the Please check if this PR needs to be included in the "Upcoming Changes" and "Release Notes" doc. If it doesn't, simply remove the label. If it does, please add an entry to our shared document, with screenshots and testing instructions if applicable, then remove the label. Thank you! ❤️ |
|
🎉 This PR is included in version 6.42.0-alpha.1 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 6.43.0-alpha.1 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
All Submissions:
Changes proposed in this Pull Request:
Adds a developer-facing README for the Reader Activation Integrations framework, modeled on
includes/data-events/README.md. Covers the framework purpose, file map, built-inespintegration, the registration flow, required and optional methods on theIntegrationbase class, settings declaration, push/pull pipelines, per-integration data event handlers, ActionScheduler groups, health checks, My Account endpoints, frontend reader registration, and a hooks/storage reference.This is documentation only — no behavioral changes.
Closes NPPD-1082.
Other information: